home *** CD-ROM | disk | FTP | other *** search
/ Australian Personal Computer 2002 November / CD 1 / APC0211D1.ISO / workshop / prog / files / ActivePerl-5.6.1.633-MSWin32.msi / _2b2e0c6e7bc1dae7099924cb03bb5cfa < prev    next >
Encoding:
Text File  |  2002-05-30  |  1.8 KB  |  64 lines
  1. =head1 NAME
  2.  
  3. messageBox  -  pop up a message window and wait for user response.
  4.  
  5. =for category Popups and Dialogs
  6.  
  7. =head1 SYNOPSIS
  8.  
  9. S<    >I<$response> = I<$widget>-E<gt>B<messageBox>(I<-option> =E<gt> I<value>, ... );
  10.  
  11. =head1 DESCRIPTION
  12.  
  13. This method uses L<Tk::Dialog|Tk::Dialog> to quickly create several common dialog boxes.
  14. A dialog widget consists of a message, an icon and a set of buttons (see
  15. the I<-type> option).  After the message window is popped up,  B<messageBox>
  16. waits  for the user to select one of the buttons and return the button text.
  17. NOTE:  unlike B<Tk::Dialog> which creates its widget once and can be used
  18. many times, the B<messageBox> window is created every time it's used.
  19.  
  20. The following option/value pairs are supported:
  21.  
  22. =over 4
  23.  
  24. =item B<-default>
  25.  
  26. The case-sensitive symbolic name of the default button
  27. for this message window  ('OK',  'Cancel'  and  so
  28. on).  See  B<-type>  for a list of the symbolic names.
  29. If the message box has  just  one  button  it  will
  30. automatically  be  made  the  default, otherwise if
  31. this option is not specified, there  won't  be  any
  32. default button.
  33.  
  34. =item B<-icon>
  35.  
  36. Specifies an icon to display. Any of the builtin Tk bitmaps can
  37. specified.
  38.  
  39. =item B<-message>
  40.  
  41. Specifies the message to display.
  42.  
  43. =item B<-title>
  44.  
  45. Specifies  a  string to display as the title.
  46.  
  47. =item B<-type>
  48.  
  49. Specifies a predefined set of buttons to be displayed. The following values are possible:
  50. 'AbortRetryIgnore', 'OK', 'OKCancel', 'RetryCancel', 'YesNo' or 'YesNoCancel'.
  51.  
  52. =back
  53.  
  54. =head1 EXAMPLE
  55.  
  56. I<$repsonse> = I<$mw>-E<gt>B<messageBox>(-icon =E<gt> 'questhead', -message =E<gt> 'Hello World!', -title =E<gt> 'My title', -type =E<gt> 'AbortRetryIgnore', -default =E<gt> 'Retry');
  57.  
  58. =head1 AUTHOR
  59.  
  60. Stephen.O.Lidie@Lehigh.EDU.  98/05/25
  61.  
  62. =cut
  63.  
  64.